home *** CD-ROM | disk | FTP | other *** search
/ Box' of X 3 / Box' of X 3.iso / x-viewer / unix / x11 / xv2r1.txt < prev   
Encoding:
Text File  |  1992-08-06  |  7.0 KB  |  187 lines
  1. /***********************************************************
  2. Copyright 1991 by Digital Equipment Corporation, Maynard, Massachusetts,
  3. and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
  4.  
  5.                         All Rights Reserved
  6.  
  7. Permission to use, copy, modify, and distribute this software and its 
  8. documentation for any purpose and without fee is hereby granted, 
  9. provided that the above copyright notice appear in all copies and that
  10. both that copyright notice and this permission notice appear in 
  11. supporting documentation, and that the names of Digital or MIT not be
  12. used in advertising or publicity pertaining to distribution of the
  13. software without specific, written prior permission.  
  14.  
  15. DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  16. ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  17. DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  18. ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  19. WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  20. ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  21. SOFTWARE.
  22.  
  23. X Window System is a trademark of Massachusetts Institute of Technology.
  24. RasterOps is a registered trademark of RasterOps Corporation.
  25.  
  26. ******************************************************************/
  27. /*
  28. ** File: 
  29. **
  30. **   README --- Guide to building Xv into your X Window System(TM)
  31. **
  32. **              The kit Now includes a full sample server implementation 
  33. **              for the DECStation 5000/TX (RasterOps) display.
  34. **
  35. **              I want to acknowledge the great efforts of Ed Goei
  36. **              (Digital's Western Software Labs), in contributing
  37. **              the TX device support code.
  38. **              
  39. ** Author: 
  40. **
  41. **   David Carver (Digital Workstation Engineering/Project Athena)
  42. **
  43. */
  44.  
  45.        The Xv distribution kit contains an Xv extension source tree
  46.   and a core server tree which contains files that were modified to
  47.   link the Xv server into an X11R5 server.
  48.  
  49.   This distribution also contains the files necessary to build the Xtx
  50.   server for a DECStation5000/RasterOps display running a version of
  51.   ULTRIX newer than 4.2.  These modules include
  52.  
  53.     ddx/cfb32            /* 24 plane drawing code */
  54.     ddx/dec/tx            /* display specific code */
  55.     ddx/dec/ws            /* binding to ws interface */
  56.  
  57.   It should be noted that this code hasn't been well tested.  It is
  58.   provided because it might be useful in porting software to similar
  59.   display systems.  The 24 plane drawing code is really the cfb
  60.   drawing code compiled for 24 planes, with a few modifications for
  61.   allowing the mixing of 8 and 24 plan drawing.
  62.  
  63.  
  64.   Xv Changes
  65.   ----------
  66.  
  67.       No changes have been made to the Xv protocol since the alpha
  68.   release earlier in the summer.  Several bugs have been fixed in the
  69.   RasterOps bindings and but the DI code has undergone minimal change.
  70.  
  71.  
  72.   Xv Sources
  73.   ----------
  74.  
  75.   The Xv extension source tree contains the following directories
  76.  
  77.     ./extensions/xv
  78.     ./extensions/xv/doc        /* library and protocol documents */
  79.     ./extensions/xv/include        /* header files */
  80.     ./extensions/xv/lib        /* library modules */
  81.     ./extensions/xv/server        /* server modules */
  82.     ./extensions/xv/test        /* test programs */
  83.     ./extensions/xv/man        /* library man pages */
  84.  
  85.   The extension sources can be integrated with an X11R5 build tree in
  86.   one of two ways: either by moving the entire directory tree:
  87.  
  88.     ./extensions/xv ---> $(TOP)/extensions
  89.  
  90.   or by moving the individual subdirectories into their respective
  91.   X11R5 extension subdirectories:
  92.  
  93.     ./extensions/xv/server ---> $(TOP)/extensions/server
  94.     ./extensions/xv/lib ---> $(TOP)/extensions/lib
  95.     ./extensions/xv/include ---> $(TOP)/extensions/include
  96.     ./extensions/xv/test ---> $(TOP)/extensions/test
  97.  
  98.   In either case you must edit the parent directory Imakefile(s) and add
  99.   xv to the SUBDIRS macro.
  100.  
  101.   Look in ./extensions to see how the first method was implemented.
  102.  
  103.  
  104.   New Adaptor Types
  105.   -----------------
  106.  
  107.   For new adaptor types, one or more adaptor dependent Xv files must
  108.   be added to the Xv server directory.  The Xv server Imakefile must
  109.   be modified to build modules for the the new adaptor types.  Look in
  110.   ./extensions/xv/server/Imakefile to see how the Xv server Imakefile
  111.   is structured for existing adaptors.  
  112.  
  113.   We have included an Xv adaptor dependent module for the
  114.   RasterOps(TM) Picture In a Picture, or PIP, video adaptor.  The
  115.   ./extensions/xv/xvrop.c modules interfaces with the PIP device
  116.   interface found in ./server/ddx/dec/tx for the DECStation 5000.
  117.  
  118.  
  119.   Modified Files
  120.   --------------
  121.  
  122.   $(TOP)/server/Imakefile needs to be modified to reference and link
  123.   with the Xv extension.  Look in ./server/Imakefile to see how our
  124.   server Imakefile is structured.  Look in Imakefile.diff for a list
  125.   of difference between the X11R5 Imakefile and ours.
  126.  
  127.   $(TOP)/server/ddx/mi/miinitext.c needs to reference the Xv extension
  128.   initialization procedure added.  Look in ./server/ddx/mi/miinitext.c
  129.   to see how we made the additions.
  130.  
  131.   Somewhere in your device dependent screen initialization you need to
  132.   call the appropriate Xv adaptor initialization procedures.  Look in
  133.   ./extensions/xv/server/xvrop.c for an example of how a adaptor
  134.   screen initialization procedure might be structured.
  135.  
  136.  
  137.   Configuration
  138.   -------------
  139.  
  140.   To inform the X11R5 build that you wish to include the Xv extension
  141.   you need to edit your configuration file(s).  The following symbol
  142.   definition needs to made
  143.  
  144.     #define BuildXvExt YES
  145.  
  146.   To inform X11R5 modules that have conditional Xv references to
  147.   include those references, you much modify the build symbol
  148.   ExtensionDefines:
  149.  
  150.     #define ExtensionOSDefines ... -DXV ...
  151.  
  152.   To inform the Xv server build of what video adaptors you wish to
  153.   support you need to define one or more symbols of the following
  154.   form:
  155.  
  156.     #define BuildXvParallax YES
  157.     #define BuildXvRasterOps YES
  158.     #define BuildXvYOURADAPTORNAME YES
  159.  
  160.   Look in ./extensions/xv/server/Imakefile to see how those symbols
  161.   are used.  If you define no such symbols, the Xv extension will be
  162.   build correctly and included into your server, but support for your
  163.   special video adaptors will be missing.
  164.  
  165.   Note that for the DS5000/RasterOps system, the server name is Xtx.
  166.   The configuration file needs to define the appropriate symbol:
  167.  
  168.     #define XtxServer YES
  169.  
  170.   Of course the corresponding changes need to be made to the server
  171.   Imakefile file.  For examples of these changes see our versions of
  172.   the files included with the kit.
  173.  
  174.   If you wish to build an Xtx server, you must first install (copy)
  175.   the ddx/cfb32 and ddx/dec/tx directory trees into your server build
  176.   tree, and copy the contents of the ddx/dec/ws directory into the
  177.   corresponding directory in your build tree.
  178.  
  179.   Building
  180.   --------
  181.  
  182.   If you perform a `make World' after making the above changes
  183.   everything should build fine.  If you are going to do an incremental
  184.   build, note that before the Xv library and test files will build you
  185.   need to do get the header files into $(TOP)/X11/extensions
  186.   directory.  Normally the `make includes' pass does this.
  187.